home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / string / stringArray.man < prev    next >
Text File  |  1991-04-23  |  1KB  |  47 lines
  1. '\" Copyright 1991 Regents of the University of California
  2. '\" Permission to use, copy, modify, and distribute this
  3. '\" documentation for any purpose and without fee is hereby
  4. '\" granted, provided that this notice appears in all copies.
  5. '\" The University of California makes no representations about
  6. '\" the suitability of this material for any purpose.  It is
  7. '\" provided "as is" without express or implied warranty.
  8. '\" 
  9. '\" $Header: /sprite/src/lib/c/string/RCS/stringArray.man,v 1.1 91/04/23 18:00:46 kupfer Exp $ SPRITE (Berkeley)
  10. '/" 
  11. .so \*(]ltmac.sprite
  12. .HS String lib
  13. .BS
  14. '\" Note:  do not modify the .SH NAME line immediately below!
  15. .SH NAME
  16. String_SaveArray, String_FreeArray \- copy and destroy null-terminated string array
  17. .SH SYNOPSIS
  18. .nf
  19. \fB#include <spriteString.h>\fR
  20. .sp
  21. char **
  22. \fBString_SaveArray\fR(\fIstringsPtr\fP)
  23. .sp
  24. char **
  25. \fBString_FreeArray\fR(\fIstringsPtr\fR)
  26. .SH ARGUMENTS
  27. .AS char **stringsPtr
  28. .AP char **stringsPtr in
  29. Pointer to a null-terminated array of string pointers.
  30. .BE
  31.  
  32. .SH DESCRIPTION
  33. .PP
  34. These routines create and destroy null-terminated arrays of strings.
  35. They are useful for making copies of the
  36. .B argv
  37. argument array or of a host alias list.
  38. .B String_SaveArray
  39. creates new copies of the strings and of the array of pointers.
  40. .B String_FreeArray
  41. frees the strings and the array.  It returns a nil pointer that can be
  42. used to nil out the given
  43. .IR stringsPtr .
  44.  
  45. .SH KEYWORDS
  46. string, copy
  47.